/**
 * Copyright (c) 2009 Teoti Graphix, LLC See:
 *     http://tkarchitecture.teotigraphix.org
 * 
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 * 
 * @author Michael Schmalle mschmalle@teotigraphix.com
 */
package org.example.ui.component
{

/**
 * The <code>LoginComponent</code>'s skin interface.
 * 
 * <p>Defines required;</p>
 * <ul>
 * <li>State messages.</li>
 * <li>Input labels.</li>
 * <li>Public login api the communicates with the internal model of the
 * login component</li>
 * </ul>
 * 
 * @author Michael Schmalle
 * @copyright Teoti Graphix, LLC
 */
public interface ILoginComponent
{
	//--------------------------------------------------------------------------
	//
	//  Properties
	//
	//--------------------------------------------------------------------------
	
	//----------------------------------
	//  loggingInText
	//----------------------------------

	/**
	 * Message to display when logging in.
	 *
	 * @default "Logging in..."
	 */
	function get loggingInText():String 

	/** 
	 * @private 
	 */
	function set loggingInText(value:String):void 

	//----------------------------------
	//  loggedInText
	//----------------------------------

	/**
	 * Message to display when login succeeded.
	 *
	 * @default "Login Successful"
	 */
	function get loggedInText():String 
	
	/** 
	 * @private 
	 */
	function set loggedInText(value:String):void 
	
	//----------------------------------
	//  loginMessageText
	//----------------------------------

	/**
	 * Label to describe the progress of the login action.
	 *
	 * @default ""
	 */
	function get loginMessageText():String 
	
	/** 
	 * @private
	 */
	function set loginMessageText(value:String):void;
	
	//----------------------------------
	//  loginLabel
	//----------------------------------

	/**
	 * Label to describe the login input field.
	 *
	 * @default "Login"
	 */
	function get loginLabel():String 
	
	/** 
	 * @private 
	 */
	function set loginLabel(value:String):void 

	//----------------------------------
	//  passwordLabel
	//----------------------------------

	/**
	 * Label to describe the password input field.
	 *
	 * @default "Password"
	 */
	function get passwordLabel():String 
	
	/** 
	 * @private
	 */
	function set passwordLabel(value:String):void 
	
	//--------------------------------------------------------------------------
	//
	//  Methods
	//
	//--------------------------------------------------------------------------
	
	/**
	 * To be called if the login action has failed.
	 */
	function loginFailed():void 
	
	/**
	 * To be called if the login action has succeeded.
	 */
	function loginSucceeded():void 
}
}